Skip to main content

Update Logo

PUT /api/v1/InvoiceSetting/UpdateLogo

Description

This endpoint is used to update logo settings. It allows users to modify the logo settings for invoices.

Headers:

  • Content-Type: application/json

ApiKey:

  • No API key required

Path Parameters:

  • version: string, required

Request Body:

  • UpdateInvoiceLogoSettingsRequest object containing the updated logo settings

URL:

  • PUT: {{baseUrl API url}}/api/v1/InvoiceSetting/UpdateLogo

Response:

  • 200: Success, indicates that the logo settings have been successfully updated.

Error Codes:

  • 400: Bad Request, the request body is not valid or missing required fields.

  • 404: Resource not found, the specified version or setting does not exist.

  • 500: Internal server error, something went wrong while processing the request.

Example Request URL:

PUT /api/v1/InvoiceSetting/UpdateLogo
Content-Type: application/json
{
"logoPath": "path/to/new/logo",
"isActive": true
}

Example Response:

HTTP/1.1 200 OK

Notes:

  • The request body should contain the UpdateInvoiceLogoSettingsRequest object, which includes the updated logo settings.

  • The response indicates that the logo settings have been successfully updated.

Method: PUT

/api/v1/InvoiceSetting/UpdateLogo

Headers

Content-TypeValue
Content-Typeapplication/json

Body (raw)

{
"docId": "<uuid>",
"base64": "<string>",
"fileName": "<string>"
}

Response: 200

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /api/v1/InvoiceSetting/UpdateLogo \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!